qaGobiApiFms.h

Go to the documentation of this file.

/*
 * Copyright: © 2011-2105 Sierra Wireless, Inc. all rights reserved
 */
#ifndef __GOBI_API_FMS_H__
#define __GOBI_API_FMS_H__

#ifdef __cplusplus
extern "C" {
#endif

/* MC7xx CWE Header SPKGS defines */
#define SLQSFWINFO_MODELID_SZ     20 
#define SLQSFWINFO_BOOTVERSION_SZ 85
#define SLQSFWINFO_APPVERSION_SZ  85
#define SLQSFWINFO_SKU_SZ         15 
#define SLQSFWINFO_PACKAGEID_SZ   85
#define SLQSFWINFO_CARRIER_SZ     20 
#define SLQSFWINFO_PRIVERSION_SZ  16
#define SLQSFWINFO_CUR_CARR_NAME  17
#define SLQSFWINFO_CUR_CARR_REV   13
#define SLQSFWINFO_PART_NO_SZ     15
/* Gobi .mbn image defines */
#define GOBI_MBN_IMG_ID_SIZE   16
#define TOTAL_IMAGE_ID_STRING_SIZE 100 
#define GOBI_MBN_IMG_ID_STR_LEN   TOTAL_IMAGE_ID_STRING_SIZE
#define GOBI_MBN_BUILD_ID_STR_LEN TOTAL_IMAGE_ID_STRING_SIZE
#define GOBI_LISTENTRIES_MAX      2
#define GOBI_SET_IMG_PREF_RSPLEN  40
#define DEVICE_SHUTDOWN           5
#define DEVICE_RESET              4
#define DEVICE_OFFLINE            3

#define FIRMWARE_UPDATE_SUCCESS   0x01
#define FIRMWARE_UPDATE_FAIL      0x01
#define PRI_UPDATE_FAIL           0x02
#define FIRMWARE_UPGRADE_SUCCESS  0x00

#define IMG_ID_LEN   TOTAL_IMAGE_ID_STRING_SIZE
#define BUILD_ID_LEN   TOTAL_IMAGE_ID_STRING_SIZE //100
#define G3K_FIRMWARE_DOWNLOAD  1
#define SPKG_FIRMWARE_DOWNLOAD 2

#define UNIQUE_ID_LEN     16
#define BUILD_ID_MAX_LEN  255
#define IMGDETAILS_LEN    16
#define MAX_IMAGE_IDE_ELEMENTS 50

struct fwinfo_s
{
    ULONG FirmwareID;
    ULONG Technology;
    ULONG Carrier;
    ULONG Region;
    ULONG GPSCapability;
};

struct slqsfwinfo_s{
    CHAR modelid_str[SLQSFWINFO_MODELID_SZ];
    CHAR bootversion_str[SLQSFWINFO_BOOTVERSION_SZ];
    CHAR appversion_str[SLQSFWINFO_APPVERSION_SZ];
    CHAR sku_str[SLQSFWINFO_SKU_SZ];
    CHAR packageid_str[SLQSFWINFO_PACKAGEID_SZ];
    CHAR carrier_str[SLQSFWINFO_CARRIER_SZ];
    CHAR priversion_str[SLQSFWINFO_PRIVERSION_SZ];
    CHAR cur_carr_name[SLQSFWINFO_CUR_CARR_NAME];
    CHAR cur_carr_rev[SLQSFWINFO_CUR_CARR_REV];
};

struct slqsfwpartno_s{
    CHAR partno_str[SLQSFWINFO_PART_NO_SZ];
};

struct qmifwinfo_s
{
    union
    {
        struct fwinfo_s     g;
        struct slqsfwinfo_s s;
    } dev;
};

extern ULONG GetImageStore(
    WORD imageStorePathSize,
    CHAR *pImageStorePath );

enum eGobiImageTech
{
   eGOBI_IMG_TECH_CDMA = 0,      /* 0 - CDMA */
   eGOBI_IMG_TECH_UMTS           /* 1 - UMTS */
};

enum eGobiImageCarrier
{
   eGOBI_IMG_CAR_GENERIC = 1,    /* 001 */
   eGOBI_IMG_CAR_FACTORY,        /* 002 */
   eGOBI_IMG_CAR_NORF,           /* 003 */

   eGOBI_IMG_CAR_VERIZON = 101,  /* 101 */
   eGOBI_IMG_CAR_SPRINT,         /* 102 */
   eGOBI_IMG_CAR_ALLTEL,         /* 103 */
   eGOBI_IMG_CAR_BELL,           /* 104 */
   eGOBI_IMG_CAR_TELUS,          /* 105 */
   eGOBI_IMG_CAR_US,             /* 106 */
   eGOBI_IMG_CAR_TELSTRA1,       /* 107 */
   eGOBI_IMG_CAR_CHINA_UNICOM,   /* 108 */
   eGOBI_IMG_CAR_TELCOM_NZ,      /* 109 */
   eGOBI_IMG_CAR_SK_TELCOM1,     /* 110 */
   eGOBI_IMG_CAR_RELIANCE1,      /* 111 */
   eGOBI_IMG_CAR_TATA,           /* 112 */
   eGOBI_IMG_CAR_METROPCS,       /* 113 */
   eGOBI_IMG_CAR_LEAP,           /* 114 */
   eGOBI_IMG_CAR_KDDI,           /* 115 */
   eGOBI_IMG_CAR_IUSACELL,       /* 116 */
   eGOBI_IMG_CAR_CHINA_TELECOM,  /* 117 */
   eGOBI_IMG_CAR_OMH,            /* 118 */
   eGOBI_IMG_CAR_GENERIC_CDMA,   /* 119 */

   eGOBI_IMG_CAR_ATT = 201,      /* 201 */
   eGOBI_IMG_CAR_VODAFONE,       /* 202 */
   eGOBI_IMG_CAR_TMOBILE,        /* 203 */
   eGOBI_IMG_CAR_ORANGE,         /* 204 */
   eGOBI_IMG_CAR_TELEFONICA,     /* 205 */
   eGOBI_IMG_CAR_TELCOM_ITALIA,  /* 206 */
   eGOBI_IMG_CAR_3,              /* 207 */
   eGOBI_IMG_CAR_O2,             /* 208 */
   eGOBI_IMG_CAR_SFR,            /* 209 */
   eGOBI_IMG_CAR_SWISSCOM,       /* 210 */
   eGOBI_IMG_CAR_CHINA_MOBILE,   /* 211 */
   eGOBI_IMG_CAR_TELSTRA2,       /* 212 */
   eGOBI_IMG_CAR_SINGTEL_OPTUS,  /* 213 */
   eGOBI_IMG_CAR_RELIANCE2,      /* 214 */
   eGOBI_IMG_CAR_BHARTI,         /* 215 */
   eGOBI_IMG_CAR_NTT_DOCOMO,     /* 216 */
   eGOBI_IMG_CAR_EMOBILE,        /* 217 */
   eGOBI_IMG_CAR_SOFTBANK,       /* 218 */
   eGOBI_IMG_CAR_KT_FREETEL,     /* 219 */
   eGOBI_IMG_CAR_SK_TELCOM2,     /* 220 */
   eGOBI_IMG_CAR_TELENOR,        /* 221 */
   eGOBI_IMG_CAR_NETCOM,         /* 222 */
   eGOBI_IMG_CAR_TELIASONERA,    /* 223 */
   eGOBI_IMG_CAR_AMX_TELCEL,     /* 224 */
   eGOBI_IMG_CAR_BRASIL_VIVO,    /* 225 */
   eGOBI_IMG_CAR_AERIS,          /* 226 */
   eGOBI_IMG_CAR_ROGERS          /* 227 */
};

enum eGobiImageRegion
{
   eGOBI_IMG_REG_NA = 0,         /* 0 - North America */
   eGOBI_IMG_REG_LA,             /* 1 - Latin America */
   eGOBI_IMG_REG_EU,             /* 2 - Europe */
   eGOBI_IMG_REG_ASIA,           /* 3 - Asia */
   eGOBI_IMG_REG_AUS,            /* 4 - Australia */
   eGOBI_IMG_REG_GLOBAL          /* 5 - Global */
};

enum eGobiImageGPS
{
   eGOBI_IMG_GPS_NONE = 0,       /* 0 - None */
   eGOBI_IMG_GPS_STAND_ALONE,    /* 1 - Stand-alone */
   eGOBI_IMG_GPS_ASSISTED,       /* 2 - Stand-alone + AGPS + XTRA */
   eGOBI_IMG_GPS_NO_XTRA         /* 3 - Stand-alone + AGPS */
};

ULONG SLQSGetFirmwareInfo(
    struct qmifwinfo_s *pinfo );

ULONG SLQSGetImageInfoMC77xx(
    LPCSTR              path,
    struct qmifwinfo_s *pinfo );

ULONG SLQSGetImageInfoMC83xx(
    LPCSTR              path,
    struct qmifwinfo_s *pinfo );

ULONG SLQSGetImageInfo(
    LPCSTR path,
    struct qmifwinfo_s *pinfo );

ULONG SLQSGetImagePartNumber(
    LPCSTR path,
    BYTE   imgType,
    struct slqsfwpartno_s *pinfo );

ULONG UpgradeFirmware2k(
    CHAR *pDestinationPath );

#pragma pack(push)
#pragma pack(1)

struct ImageElement
{
    BYTE imageType;
    BYTE imageId[GOBI_MBN_IMG_ID_STR_LEN];
    BYTE buildIdLength;
    CHAR buildId[GOBI_MBN_BUILD_ID_STR_LEN];
};

struct PrefImageList
{
    BYTE                listSize;
    struct ImageElement listEntries[GOBI_LISTENTRIES_MAX];
};

#pragma pack(pop)

extern ULONG GetImagesPreference(
    ULONG *pImageListSize,
    struct PrefImageList  *pImageList );

extern ULONG SetImagesPreference(
    ULONG imageListSize,
    BYTE  *pImageList,
    ULONG bForceDownload,
    BYTE  modemIndex,
    ULONG *pImageTypesSize,
    BYTE  *pImageTypes );

#pragma pack(push)
#pragma pack(1)

struct ImageIdElement
{
    BYTE storageIndex;
    BYTE failureCount;
    BYTE imageID[GOBI_MBN_IMG_ID_STR_LEN];
    BYTE buildIDLength;
    CHAR buildID[GOBI_MBN_BUILD_ID_STR_LEN];
};

struct ImageIDEntries
{
    BYTE                  imageType;
    BYTE                  maxImages;
    BYTE                  executingImage;
    BYTE                  imageIDSize;
    struct ImageIdElement imageIDElement[MAX_IMAGE_IDE_ELEMENTS];
};

struct ImageList
{
    BYTE                  listSize;
    struct ImageIDEntries imageIDEntries[2];
};

#pragma pack(pop)

ULONG GetStoredImages(
    ULONG *pImageListSize,
    BYTE  *pImageList );

ULONG DeleteStoredImage(
    ULONG imageInfoSize,
    BYTE  *pImageInfo );

ULONG SLQSGetImageInfo_9x15(
    LPCSTR              path,
    BYTE                imgType,
    struct slqsfwinfo_s *pinfo );

ULONG SLQSUpgradeFirmware9x07(
    CHAR *pDestinationPath );

ULONG SLQSUpgradeFirmware9x15(
    CHAR *pDestinationPath );

ULONG SLQSGetBootVersionNumber(ULONG *bootversion);

BOOL SLQSIsSpkgFormatRequired(void);

void SLQSSetSpkgFormatRequired(BYTE isneeded);

ULONG upgrade_mc77xx_fw(
    LPCSTR path );

enum eGobiDeviceSeries
{
    eGOBI_DEV_SERIES_UNKNOWN = -1,   /* unknown */
    eGOBI_DEV_SERIES_NON_GOBI = 0,   /* Non Gobi */
    eGOBI_DEV_SERIES_G3K,            /* G3K */
    eGOBI_DEV_SERIES_SIERRA_GOBI,    /* MC9090 SL9090 */
    eGOBI_DEV_SERIES_9X15,           /* 9x15 */
    eGOBI_DEV_SERIES_9X30,           /* 9x30 */
    eGOBI_DEV_SERIES_9X07_9X50,      /* 9x07, 9x50 */
    eGobi_DEV_SERIES_MC83            /* MC83 */
};
struct sGetDeviceSeriesResult
{
    enum eGobiDeviceSeries eDevice;
    ULONG uResult;
};

void eGetDeviceSeries(struct sGetDeviceSeriesResult*);


struct SWI_STRUCT_CarrierImage
{
    ULONG     m_nCarrierId;
    ULONG     m_nFolderId;
    ULONG     m_nStorage;
    BYTE      m_FwImageId[IMG_ID_LEN];
    BYTE      m_FwBuildId[BUILD_ID_LEN];
    BYTE      m_PriImageId[IMG_ID_LEN];
    BYTE      m_PriBuildId[BUILD_ID_LEN];
};
ULONG SLQSSwiGetAllCarrierImages(ULONG *pNumOfItems,
                             struct SWI_STRUCT_CarrierImage *pCarrierImages,
                             char *pFolderPath);

ULONG DownloadToSlot(
    CHAR* path, struct slqsfwinfo_s fwImgInfo, 
    struct slqsfwinfo_s priImgInfo, BYTE slot, BYTE forceDownload);

ULONG SLQSDownloadFirmwareToSlot(
    CHAR *pPath, BYTE slot_index, BYTE force_download );

ULONG SLQSGetValidFwPriCombinations (struct ImageList *pStoredImageList,
                                     ULONG *pValidCombinationSize,
                                     struct SWI_STRUCT_CarrierImage *pValidCombinations);

ULONG SLQSSetSIMBasedImageSwitching(void);

void SLQSSetCrashStateCheckIgnore(BOOL ignore);
typedef struct
{
    BYTE imageType;
    BYTE uniqueID[UNIQUE_ID_LEN];
    BYTE buildIDLen;
    BYTE buildID[BUILD_ID_MAX_LEN];
} CurrImageInfo;

typedef struct
{
    BYTE          numEntries;
    CurrImageInfo *pCurrImgInfo;
    CHAR          priver[IMGDETAILS_LEN];
    CHAR          pkgver[IMGDETAILS_LEN];
    CHAR          fwvers[IMGDETAILS_LEN];
    CHAR          carrier[IMGDETAILS_LEN];
} CurrentImgList;

ULONG SLQSSwiGetFirmwareCurr( CurrentImgList *pCurrentImgList );

ULONG upgrade_9x07_9x50_fw(
    LPCSTR path );

ULONG SetImagePath(
    CHAR  *path,
    ULONG isMDM9x15,
    WORD  imgMask,
    BYTE  mdmProtocol);

int SLQSIsBootloaderDebugEnabled(const char* szPath,
                                 const char* pQsn );

#ifdef __cplusplus
} /* extern "C" { */
#endif

#endif /* __GOBI_API_FMS_H__ */